Example:
firstName=JohnBy default, the search filters use exact match. You can do a fulltext search on some specific columns using the fulltextFields. it's specified as comma separated columnName, for instance :
lastName=doe
Example:
firstName,lastName", "hierarchyPath": "/op:Directory.Projection", "label": "Get a Directory Projection", "name": "Directory.Projection", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.DirectoryProjection", "params": [ { "description": null, "isRequired": true, "name": "columnName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "directoryName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "variableName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "filters", "order": 0, "type": "properties", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "fulltextFields", "order": 0, "type": "stringlist", "values": [], "widget": null } ], "signature": [ "void", "void" ], "since": "5.7.2", "url": "Directory.Projection", "version": "7.10" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Creates directory entries. Entries are sent as a JSON array. Returning the created entries ids as a JSON array.", "hierarchyPath": "/op:Directory.CreateEntries", "label": "Creates directory entries", "name": "Directory.CreateEntries", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.CreateDirectoryEntries", "params": [ { "description": null, "isRequired": true, "name": "directoryName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "entries", "order": 0, "type": "string", "values": [], "widget": null } ], "signature": [ "void", "blob" ], "url": "Directory.CreateEntries", "version": "7.10" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Deletes directory entries. Entries ids to delete are sent through a JSON array. Returns deleted entries id as a JSON array.", "hierarchyPath": "/op:Directory.DeleteEntries", "label": "Deletes directory entries", "name": "Directory.DeleteEntries", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.DeleteDirectoryEntries", "params": [ { "description": null, "isRequired": true, "name": "directoryName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "entries", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "markObsolete", "order": 0, "type": "boolean", "values": [], "widget": null } ], "signature": [ "void", "blob" ], "url": "Directory.DeleteEntries", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Document.PageProvider" ], "category": "Fetch", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Perform a query or a named provider query on the repository. Result is paginated. The query result will become the input for the next operation. If no query or provider name is given, a query returning all the documents that the user has access to will be executed.", "hierarchyPath": "/op:Repository.PageProvider", "label": "PageProvider", "name": "Repository.PageProvider", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.DocumentPageProviderOperation", "params": [ { "description": null, "isRequired": false, "name": "currentPageIndex", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "documentLinkBuilder", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "escapePatternParameters", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "language", "order": 0, "type": "string", "values": [ "NXQL" ], "widget": "Option" }, { "description": null, "isRequired": false, "name": "maxResults", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "namedParameters", "order": 0, "type": "properties", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "page", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "pageSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "providerName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "query", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "queryParams", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "quotePatternParameters", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortBy", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortInfo", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortOrder", "order": 0, "type": "string", "values": [ "ASC", "DESC" ], "widget": "Option" } ], "signature": [ "void", "documents" ], "url": "Repository.PageProvider", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Notification.SendMail" ], "category": "Notification", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Send an email using the input document to the specified recipients. You can use the HTML parameter to specify whether you message is in HTML format or in plain text. Also you can attach any blob on the current document to the message by using the comma separated list of xpath expressions 'files'. If you xpath points to a blob list all blobs in the list will be attached. Return back the input document(s). If rollbackOnError is true, the whole chain will be rollbacked if an error occurs while trying to send the email (for instance if no SMTP server is configured), else a simple warning will be logged and the chain will continue.", "hierarchyPath": "/op:Document.Mail", "label": "Send E-Mail", "name": "Document.Mail", "operationClass": "org.nuxeo.ecm.automation.core.operations.notification.SendMail", "params": [ { "description": null, "isRequired": true, "name": "from", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "message", "order": 0, "type": "string", "values": [], "widget": "MailTemplate" }, { "description": null, "isRequired": true, "name": "subject", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "to", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "HTML", "order": 0, "type": "boolean", "values": [ "false" ], "widget": null }, { "description": null, "isRequired": false, "name": "Strict User Resolution", "order": 0, "type": "boolean", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "bcc", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "cc", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "files", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "replyto", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "rollbackOnError", "order": 0, "type": "boolean", "values": [ "true" ], "widget": null }, { "description": null, "isRequired": false, "name": "viewId", "order": 0, "type": "string", "values": [ "view_documents" ], "widget": null } ], "signature": [ "document", "document", "documents", "documents" ], "url": "Document.Mail", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Resultset.PageProvider" ], "category": "Fetch", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Perform a query or a named provider query on the repository. Result is paginated. The result is returned as a RecordSet (QueryAndFetch) rather than as a List of DocumentThe query result will become the input for the next operation. If no query or provider name is given, a query returning all the documents that the user has access to will be executed.", "hierarchyPath": "/op:Repository.ResultSetPageProvider", "label": "QueryAndFetch", "name": "Repository.ResultSetPageProvider", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.ResultSetPageProviderOperation", "params": [ { "description": null, "isRequired": false, "name": "documentLinkBuilder", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "language", "order": 0, "type": "string", "values": [ "NXQL", "CMIS" ], "widget": "Option" }, { "description": null, "isRequired": false, "name": "maxResults", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "namedParameters", "order": 0, "type": "properties", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "page", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "pageSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "providerName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "query", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "queryParams", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortBy", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortInfo", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortOrder", "order": 0, "type": "string", "values": [ "ASC", "DESC" ], "widget": "Option" } ], "signature": [ "void", "recordset" ], "url": "Repository.ResultSetPageProvider", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Context.RunOperationOnProvider" ], "category": "Execution Flow", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Run an operation for each page of the provider defined by the provider name, the operation input is the curent page ", "hierarchyPath": "/op:RunOperationOnProvider", "label": "Run For Each Page", "name": "RunOperationOnProvider", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.RunOperationOnProvider", "params": [ { "description": null, "isRequired": true, "name": "id", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "isolate", "order": 0, "type": "boolean", "values": [ "true" ], "widget": null } ], "signature": [ "documents", "void" ], "url": "RunOperationOnProvider", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Audit.PageProvider" ], "category": "Fetch", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Perform a query or a named provider query against Audit logs. Result is paginated. The query result will become the input for the next operation. If no query or provider name is given, a query based on default Audit page provider will be executed.", "hierarchyPath": "/op:Audit.QueryWithPageProvider", "label": "Audit Query With Page Provider", "name": "Audit.QueryWithPageProvider", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.AuditPageProviderOperation", "params": [ { "description": null, "isRequired": false, "name": "currentPageIndex", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "language", "order": 0, "type": "string", "values": [ "NXQL" ], "widget": "Option" }, { "description": null, "isRequired": false, "name": "maxResults", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "namedQueryParams", "order": 0, "type": "properties", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "page", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "pageSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "providerName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "query", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "queryParams", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortBy", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortInfo", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortOrder", "order": 0, "type": "string", "values": [ "ASC", "DESC" ], "widget": "Option" } ], "signature": [ "void", "paginable" ], "url": "Audit.QueryWithPageProvider", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Relations.GetRelations" ], "category": "Services", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Get the relations for the input document. The 'outgoing' parameter ca be used to specify whether outgoing or incoming relations should be returned. Retuns a document list.", "hierarchyPath": "/op:Document.GetLinkedDocuments", "label": "Get Linked Documents", "name": "Document.GetLinkedDocuments", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.GetRelations", "params": [ { "description": null, "isRequired": true, "name": "predicate", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "graphName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "outgoing", "order": 0, "type": "boolean", "values": [], "widget": null } ], "signature": [ "document", "documents" ], "url": "Document.GetLinkedDocuments", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "ResultSet.PaginatedQuery" ], "category": "Fetch", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Perform a query on the repository. The result set returned will become the input for the next operation.", "hierarchyPath": "/op:Repository.ResultSetQuery", "label": "ResultSet Query", "name": "Repository.ResultSetQuery", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.query.ResultSetPaginatedQuery", "params": [ { "description": null, "isRequired": true, "name": "query", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "currentPageIndex", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "language", "order": 0, "type": "string", "values": [ "NXQL", "CMIS" ], "widget": "Option" }, { "description": null, "isRequired": false, "name": "namedParameters", "order": 0, "type": "properties", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "pageSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "queryParams", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortBy", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortOrder", "order": 0, "type": "string", "values": [ "ASC", "DESC" ], "widget": "Option" } ], "signature": [ "void", "recordset" ], "since": "6.0", "url": "Repository.ResultSetQuery", "version": "7.10" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Reads directory entries. Entries ids to read are sent as a JSON array. Returns the entries as a JSON array of JSON objects containing all fields.", "hierarchyPath": "/op:Directory.ReadEntries", "label": "Reads directory entries", "name": "Directory.ReadEntries", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.ReadDirectoryEntries", "params": [ { "description": null, "isRequired": true, "name": "directoryName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "entries", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "lang", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "translateLabels", "order": 0, "type": "boolean", "values": [], "widget": null } ], "signature": [ "void", "blob" ], "url": "Directory.ReadEntries", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Document.GetUsersAndGroups" ], "category": "Users & Groups", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Fetch the users and groups that have a given permission on the input document and then set them in the context under the given key variable name. The operation returns the input document. You can later use the list of identifiers set by this operation on the context from another operation. The 'key' argument represents the variable name and the 'permission' argument the permission to check. If the 'ignore groups' argument is false then groups will be part of the result. If the 'resolve groups' argument is true then groups are recursively resolved, adding user members of these groups in place of them. Be warned that this may be a very consuming operation. If the 'prefix identifiers' argument is true, then user identifiers are prefixed by 'user:' and groups identifiers are prefixed by 'group:'.", "hierarchyPath": "/op:Context.GetUsersGroupIdsWithPermissionOnDoc", "label": "Get Users and Groups", "name": "Context.GetUsersGroupIdsWithPermissionOnDoc", "operationClass": "org.nuxeo.ecm.automation.core.operations.users.GetDocumentUsersAndGroups", "params": [ { "description": null, "isRequired": true, "name": "permission", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "variable name", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "ignore groups", "order": 0, "type": "boolean", "values": [ "false" ], "widget": null }, { "description": null, "isRequired": false, "name": "prefix identifiers", "order": 0, "type": "boolean", "values": [ "false" ], "widget": null }, { "description": null, "isRequired": false, "name": "resolve groups", "order": 0, "type": "boolean", "values": [ "false" ], "widget": null } ], "signature": [ "document", "document" ], "url": "Context.GetUsersGroupIdsWithPermissionOnDoc", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Document.Query" ], "category": "Fetch", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Perform a query on the repository. The document list returned will become the input for the next operation.", "hierarchyPath": "/op:Repository.Query", "label": "Query", "name": "Repository.Query", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.query.DocumentPaginatedQuery", "params": [ { "description": null, "isRequired": true, "name": "query", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "currentPageIndex", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "language", "order": 0, "type": "string", "values": [ "NXQL" ], "widget": "Option" }, { "description": null, "isRequired": false, "name": "namedParameters", "order": 0, "type": "properties", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "pageSize", "order": 0, "type": "integer", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "queryParams", "order": 0, "type": "stringlist", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortBy", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "sortOrder", "order": 0, "type": "string", "values": [ "ASC", "DESC" ], "widget": "Option" } ], "signature": [ "void", "documents" ], "since": "6.0", "url": "Repository.Query", "version": "7.10" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Execute a JPA query against the Audit Service. This is returning a blob with the query result. The result is a serialized JSON array. You can use the context to set query variables but you must prefix using 'audit.query.' the context variable keys that match the ones in the query.", "hierarchyPath": "/op:Audit.Query", "label": "Query Audit Service", "name": "Audit.Query", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.AuditQuery", "params": [ { "description": null, "isRequired": true, "name": "query", "order": 0, "type": "string", "values": [], "widget": "TextArea" }, { "description": null, "isRequired": false, "name": "maxResults", "order": 0, "type": "int", "values": [], "widget": null }, { "description": null, "isRequired": false, "name": "pageNo", "order": 0, "type": "int", "values": [], "widget": null } ], "signature": [ "void", "blob" ], "url": "Audit.Query", "version": "7.10" }, { "@type": "NXOperation", "aliases": [], "category": "Services", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Updates directory entries. Entries to update are sent as a JSON array. Returns the updated entries ids as a JSON array of JSON objects containing all fields", "hierarchyPath": "/op:Directory.UpdateEntries", "label": "Updates directory entries", "name": "Directory.UpdateEntries", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.UpdateDirectoryEntries", "params": [ { "description": null, "isRequired": true, "name": "directoryName", "order": 0, "type": "string", "values": [], "widget": null }, { "description": null, "isRequired": true, "name": "entries", "order": 0, "type": "string", "values": [], "widget": null } ], "signature": [ "void", "blob" ], "url": "Directory.UpdateEntries", "version": "7.10" }, { "@type": "NXOperation", "aliases": [ "Document.GetPrincipalEmails" ], "category": "Users & Groups", "contributingComponent": "org.nuxeo.ecm.core.automation.featuresContrib", "description": "Fetch the principal emails that have a given permission on the input document and then set them in the context under the given key variable name. The operation returns the input document. You can later use the list of principals set by this operation on the context from another operation. The 'key' argument represents the variable name and the 'permission' argument the permission to check. If the 'ignore groups' argument is false then groups are recursively resolved, extracting user members of these groups. Be warned that this may be a very consuming operation.